sdvaluearray module

class sd.api.sdvaluearray.SDValueArray(APIContext, handle, *args, **kwargs)

Bases: sd.api.sdvalue.SDValue

get() → sd.api.sdarray.SDArray[sd.api.sdvalue.SDValue][sd.api.sdvalue.SDValue]

Get the whole array as a SDArray

getClassName() → str

Returns the most specific name of the class this APIObject is

getItem(index: int) → Optional[sd.api.sdvalue.SDValue]

Get the SDValue at the specified index

Parameters

index – The index of the item to retrieve. Must be lower than getSize().

getSize() → int

Get the size of the array

getType() → Optional[sd.api.sdtype.SDType]

Get the value type as string

pushBack(sdValue: sd.api.sdvalue.SDValue) → None

Append the given SDValue at the end of the array. The size of the array is increased by 1.

Parameters

sdValue – The new item to add

release() → None

Releases an APIObject

static sNew(itemType: sd.api.sdtype.SDType, size: int) → Optional[sd.api.sdvaluearray.SDValueArray]

Create a new SDValueArray

Parameters

• itemType – The type of the item

• size – The initial size of the array. Usually 0

setItem(index: int, sdValue: sd.api.sdvalue.SDValue) → None

Set the item value at the specified index

Parameters

• index – The index of the item to replace. Must be lower than getSize().

• sdValue – The item that will replace the current one at the specified position